lib: Fix a few comments

Closes: #1526
Approved by: cgwalters

diff --git a/src/libostree/ostree-repo-commit.c b/src/libostree/ostree-repo-commit.c
index 7eb5ca93492ca721c9f2d53c8f35874f26795ce5..37f832c8fc1847b6bd06ca13cf74d769b8d0b1e5 100644 (file)
--- a/src/libostree/ostree-repo-commit.c
+++ b/src/libostree/ostree-repo-commit.c
@@ -2214,7 +2214,7 @@ metadata_size_valid (OstreeObjectType objtype,
  * @cancellable: Cancellable
  * @error: Error
  *
- * Store the metadata object @variant.  Return the checksum
+ * Store the metadata object @object.  Return the checksum
  * as @out_csum.
  *
  * If @expected_checksum is not %NULL, verify it against the

diff --git a/src/libostree/ostree-repo-finder.c b/src/libostree/ostree-repo-finder.c
index 829e8c6d8ea94af269dc738cd0f7b54bca2b09bd..4cad81f92fde683e21ead763f602bee8cdc421b6 100644 (file)
--- a/src/libostree/ostree-repo-finder.c
+++ b/src/libostree/ostree-repo-finder.c
@@ -132,8 +132,8 @@ static void resolve_cb (GObject      *obj,
  * which the result provides. If the result provides the latest commit for a ref
  * across all of the results, the checksum will be set. Otherwise, if the
  * result provides an outdated commit, or doesn’t provide a given ref at all,
- * the ref will not be set. Results which provide none of the requested @refs
- * may be listed with an empty refs map.
+ * the checksum will not be set. Results which provide none of the requested
+ * @refs may be listed with an empty refs map.
  *
  * Pass the results to ostree_repo_pull_from_remotes_async() to pull the given
  * @refs from those remotes.

diff --git a/src/libostree/ostree-repo-pull.c b/src/libostree/ostree-repo-pull.c
index 6170b011d78f20679035460c9f7683b8117e0e4a..0eefbf7b5f95c265aacc0b7465d80e1b41fc6da9 100644 (file)
--- a/src/libostree/ostree-repo-pull.c
+++ b/src/libostree/ostree-repo-pull.c
@@ -5235,7 +5235,7 @@ find_remotes_cb (GObject      *obj,
   for (i = 0; i < results->len; i++)
     {
       OstreeRepoFinderResult *result = g_ptr_array_index (results, i);
-      g_autoptr(GHashTable) validated_ref_to_checksum = NULL;  /* (element-type utf8 utf8) */
+      g_autoptr(GHashTable) validated_ref_to_checksum = NULL;  /* (element-type OstreeCollectionRef utf8) */
       gsize j, n_latest_refs;
 
       /* Previous error processing this result? */

diff --git a/src/libostree/ostree-repo.c b/src/libostree/ostree-repo.c
index 8ff0d961be59ce8ff77d0f914d4d58b3790c64c5..7d593f506ed06fd4bb8754cdc1e5505018a4eaf0 100644 (file)
--- a/src/libostree/ostree-repo.c
+++ b/src/libostree/ostree-repo.c
@@ -5311,11 +5311,11 @@ summary_add_ref_entry (OstreeRepo       *self,
  * `core/commit-update-summary` is set.
  *
  * If the `core/collection-id` key is set in the configuration, it will be
- * included as %OSTREE_SUMMARY_COLLECTION_ID in the summary file. Refs from the
- * `refs/mirrors` directory will be included in the generated summary file,
- * listed under the %OSTREE_SUMMARY_COLLECTION_MAP key. Collection IDs and refs
- * in %OSTREE_SUMMARY_COLLECTION_MAP are guaranteed to be in lexicographic
- * order.
+ * included as %OSTREE_SUMMARY_COLLECTION_ID in the summary file. Refs that
+ * have associated collection IDs will be included in the generated summary
+ * file, listed under the %OSTREE_SUMMARY_COLLECTION_MAP key. Collection IDs
+ * and refs in %OSTREE_SUMMARY_COLLECTION_MAP are guaranteed to be in
+ * lexicographic order.
  */
 gboolean
 ostree_repo_regenerate_summary (OstreeRepo     *self,